<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::ParticleDynamics&lt; ReturnType, BodyType, ParticlesType, MaterialType &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_particle_dynamics.html">ParticleDynamics</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_s_p_h_1_1_particle_dynamics-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::ParticleDynamics&lt; ReturnType, BodyType, ParticlesType, MaterialType &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Particle dynamics base class Bodies are involved the dynamics of a designated body and the bodies interacting with this body.  
 <a href="class_s_p_h_1_1_particle_dynamics.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="base__particle__dynamics_8h_source.html">base_particle_dynamics.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="class_s_p_h_1_1_dynamics.html">SPH::Dynamics&lt; ReturnType &gt;</a>.</p>

<p>Inherited by <a class="el" href="class_s_p_h_1_1_get_diffusion_time_step_size.html">SPH::GetDiffusionTimeStepSize&lt; SolidBody, SolidParticles, Solid &gt;</a>, <a class="el" href="class_s_p_h_1_1fluid__dynamics_1_1_transport_velocity_formulation.html">SPH::fluid_dynamics::TransportVelocityFormulation</a>, <a class="el" href="class_s_p_h_1_1_get_diffusion_time_step_size.html">SPH::GetDiffusionTimeStepSize&lt; BodyType, BaseParticlesType, BaseMaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_particle_reduce.html">SPH::PartDynamicsByParticleReduce&lt; ReturnType, ReduceOperation, BodyType, ParticlesType, BodyPartByParticleType, MaterialType &gt;</a>, and <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html">SPH::ParticleDynamicsReduce&lt; ReturnType, ReduceOperation, BodyType, ParticlesType, MaterialType &gt;</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a129036fc16e69eb21e69a259ca20036a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_particle_dynamics.html#a129036fc16e69eb21e69a259ca20036a">ParticleDynamics</a> (<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> *body)</td></tr>
<tr class="separator:a129036fc16e69eb21e69a259ca20036a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_s_p_h_1_1_dynamics"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_p_h_1_1_dynamics')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_s_p_h_1_1_dynamics.html">SPH::Dynamics&lt; ReturnType &gt;</a></td></tr>
<tr class="memitem:a343c5cd5886c1c142ec2f995449029f5 inherit pub_methods_class_s_p_h_1_1_dynamics"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_dynamics.html#a343c5cd5886c1c142ec2f995449029f5">Dynamics</a> ()</td></tr>
<tr class="separator:a343c5cd5886c1c142ec2f995449029f5 inherit pub_methods_class_s_p_h_1_1_dynamics"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c31cbb0b72279f481468c7c0f10da8e inherit pub_methods_class_s_p_h_1_1_dynamics"><td class="memItemLeft" align="right" valign="top">virtual ReturnType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_dynamics.html#a8c31cbb0b72279f481468c7c0f10da8e">exec</a> (Real dt=0.0)=0</td></tr>
<tr class="separator:a8c31cbb0b72279f481468c7c0f10da8e inherit pub_methods_class_s_p_h_1_1_dynamics"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4748911d3214925588db6ca4134c7645 inherit pub_methods_class_s_p_h_1_1_dynamics"><td class="memItemLeft" align="right" valign="top"><a id="a4748911d3214925588db6ca4134c7645"></a>
virtual ReturnType&#160;</td><td class="memItemRight" valign="bottom"><b>parallel_exec</b> (Real dt=0.0)=0</td></tr>
<tr class="separator:a4748911d3214925588db6ca4134c7645 inherit pub_methods_class_s_p_h_1_1_dynamics"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ad17dd35a0798d79d490d84f85f98cd7a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_particle_dynamics.html#ad17dd35a0798d79d490d84f85f98cd7a">setupDynamics</a> (Real dt=0.0) override</td></tr>
<tr class="separator:ad17dd35a0798d79d490d84f85f98cd7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a4500fb63cd892c13811bd6cfe5fbf7ac"><td class="memItemLeft" align="right" valign="top"><a id="a4500fb63cd892c13811bd6cfe5fbf7ac"></a>
BodyType *&#160;</td><td class="memItemRight" valign="bottom"><b>body_</b></td></tr>
<tr class="separator:a4500fb63cd892c13811bd6cfe5fbf7ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51346b4cba7e0e0acb4f28a85641f241"><td class="memItemLeft" align="right" valign="top"><a id="a51346b4cba7e0e0acb4f28a85641f241"></a>
ParticlesType *&#160;</td><td class="memItemRight" valign="bottom"><b>particles_</b></td></tr>
<tr class="separator:a51346b4cba7e0e0acb4f28a85641f241"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d79b6e26f7ec6bd3c74d10fe666806e"><td class="memItemLeft" align="right" valign="top"><a id="a0d79b6e26f7ec6bd3c74d10fe666806e"></a>
MaterialType *&#160;</td><td class="memItemRight" valign="bottom"><b>material_</b></td></tr>
<tr class="separator:a0d79b6e26f7ec6bd3c74d10fe666806e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38f59772207191ae1046143ace795664"><td class="memItemLeft" align="right" valign="top"><a id="a38f59772207191ae1046143ace795664"></a>
<a class="el" href="namespace_s_p_h.html#ac592bbe202be73decfcbfe8201484ffa">SplitCellLists</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>split_cell_lists_</b></td></tr>
<tr class="separator:a38f59772207191ae1046143ace795664"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77205aeffd8f5cffa5a2af3986e927d7"><td class="memItemLeft" align="right" valign="top"><a id="a77205aeffd8f5cffa5a2af3986e927d7"></a>
<a class="el" href="class_s_p_h_1_1_base_mesh_cell_linked_list.html">BaseMeshCellLinkedList</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>mesh_cell_linked_list_</b></td></tr>
<tr class="separator:a77205aeffd8f5cffa5a2af3986e927d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_attribs_class_s_p_h_1_1_global_static_variables"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_class_s_p_h_1_1_global_static_variables')"><img src="closed.png" alt="-"/>&#160;Static Public Attributes inherited from <a class="el" href="class_s_p_h_1_1_global_static_variables.html">SPH::GlobalStaticVariables</a></td></tr>
<tr class="memitem:ade84c016ddfa66794108619277313c82 inherit pub_static_attribs_class_s_p_h_1_1_global_static_variables"><td class="memItemLeft" align="right" valign="top">static Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_global_static_variables.html#ade84c016ddfa66794108619277313c82">physical_time_</a> = 0.0</td></tr>
<tr class="separator:ade84c016ddfa66794108619277313c82 inherit pub_static_attribs_class_s_p_h_1_1_global_static_variables"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class ReturnType, class BodyType, class ParticlesType = BaseParticles, class MaterialType = BaseMaterial&gt;<br />
class SPH::ParticleDynamics&lt; ReturnType, BodyType, ParticlesType, MaterialType &gt;</h3>

<p>Particle dynamics base class Bodies are involved the dynamics of a designated body and the bodies interacting with this body. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a129036fc16e69eb21e69a259ca20036a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a129036fc16e69eb21e69a259ca20036a">&#9670;&nbsp;</a></span>ParticleDynamics()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ReturnType, class BodyType, class ParticlesType = BaseParticles, class MaterialType = BaseMaterial&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_s_p_h_1_1_particle_dynamics.html">SPH::ParticleDynamics</a>&lt; ReturnType, BodyType, ParticlesType, MaterialType &gt;::<a class="el" href="class_s_p_h_1_1_particle_dynamics.html">ParticleDynamics</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> *&#160;</td>
          <td class="paramname"><em>body</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad17dd35a0798d79d490d84f85f98cd7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad17dd35a0798d79d490d84f85f98cd7a">&#9670;&nbsp;</a></span>setupDynamics()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ReturnType, class BodyType, class ParticlesType = BaseParticles, class MaterialType = BaseMaterial&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="class_s_p_h_1_1_particle_dynamics.html">SPH::ParticleDynamics</a>&lt; ReturnType, BodyType, ParticlesType, MaterialType &gt;::setupDynamics </td>
          <td>(</td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>dt</em> = <code>0.0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>the function for set global parameters for the particle dynamics </p>

<p>Implements <a class="el" href="class_s_p_h_1_1_dynamics.html">SPH::Dynamics&lt; ReturnType &gt;</a>.</p>

<p>Reimplemented in <a class="el" href="class_s_p_h_1_1solid__dynamics_1_1_damping_by_splitting_algorithm.html#a92ba1994ba812d4d8d61048014223e25">SPH::solid_dynamics::DampingBySplittingAlgorithm</a>, <a class="el" href="class_s_p_h_1_1solid__dynamics_1_1_constrain_solid_body_part_by_sim_body.html#a047c4e59137413e06ab1db890768254f">SPH::solid_dynamics::ConstrainSolidBodyPartBySimBody</a>, <a class="el" href="class_s_p_h_1_1relax__dynamics_1_1_finalizing_particle_relaxation.html#ae1127336cd71ecf31625cb3e7596edd0">SPH::relax_dynamics::FinalizingParticleRelaxation</a>, <a class="el" href="class_s_p_h_1_1_mirror_boundary_condition_in_axis_direction_1_1_creating_ghost_particles.html#a70febe9d33391cd0073212d9aec1a42d">SPH::MirrorBoundaryConditionInAxisDirection::CreatingGhostParticles</a>, <a class="el" href="class_s_p_h_1_1fluid__dynamics_1_1_transport_velocity_correction.html#aa484e2ac39af4d9403f49debf4cb6150">SPH::fluid_dynamics::TransportVelocityCorrection</a>, and <a class="el" href="class_s_p_h_1_1_initialize_a_time_step.html#ad2cbb32573266c1098331e0b755a5866">SPH::InitializeATimeStep</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>SPHINXsys/src/shared/particle_dynamics/<a class="el" href="base__particle__dynamics_8h_source.html">base_particle_dynamics.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
